home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 5 / Apprentice-Release5.iso / Utilities / Communications / InterSLIP Remote 1.2.2 / Readme < prev    next >
Text File  |  1996-05-03  |  15KB  |  317 lines

  1. InterSLIP Remote V1.2.2 Documentation
  2.  
  3. Content
  4.  
  5. • About InterSLIP Remote
  6. • Connecting/Disconnecting
  7. • Link States
  8. • Auto-Redial
  9. • Time Connected
  10. • Connection Sound
  11. • Scripting InterSLIP Remote
  12. • Preferences dialog
  13. • Log
  14. • Version Overview
  15.    - Future plans
  16. • Disclaimer
  17. • Shareware
  18.    - Kagi Shareware
  19. • Thanks to
  20. • How to contact the author
  21.  
  22.  
  23. About InterSLIP Remote
  24.  
  25. With InterSLIP Remote you can control InterSLIP. You still need InterSLIP; InterSLIP Remote is just an addition. To create new configurations, edit them and switch between them you still need InterSLIP Setup.
  26. InterSLIP Remote has four main features which InterSLIP Control and InterSLIP Setup does not have: with InterSLIP Remote you can measure the time you are connected to the Internet, it can redial (this feature can be turned on or off) if the modem of your provider is busy, it keeps a detailed log of all your connects/disconnects and connection times, and last but nor least it is scriptable.
  27.  
  28.  
  29. Connecting/Disconnecting
  30.  
  31. There are three possibilities to connect/disconnect:
  32. • Click on the little phone with the handset up of the "Control"-window to connect and click on the phone with the handset down to disconnect
  33. • Choose "Connect" to connect or "Disconnect" to disconnect from the "File"-menu
  34. • Type C to connect or D to disconnect.
  35.  
  36.  
  37. Link States
  38.  
  39. • Idle
  40. You are not connected to the Internet.
  41.  
  42. • Waiting for modem
  43. InterSLIP is telling your modem to start dialing
  44.  
  45. • Dialing
  46. Your modem is dialing the number of your Slip account. You can choose it with InterSLIP Setup. Then it is connecting the modem of your Internet Service provider.
  47.  
  48. • Logging into gateway
  49. InterSLIP is executing the CCL script you chose with InterSLIP Setup in the "Settings" dialog box of your configuration. There the CCL script is called "Gateway script". It will log you in to your gateway. Messages sent by CCL scripts to the user will be displayed in the second line of the "Control"-window.
  50.  
  51. • Up and running
  52. You are connected to the Internet.
  53.  
  54.  
  55. Auto-Redial
  56.  
  57. You can turn Auto-Redial on or off by
  58. • clicking on the small icon with the dial disc of the "Control"-window. It will be crossed out when Auto-Redialing is disabled.
  59. • choosing "Auto-Redial" from the "File"-menu
  60. • typing A
  61.  
  62. If Auto-Redial is active, it will start another try to connect after a certain amount seconds. You can set it using the "Preferences"-dialog box. InterSLIP Remote interprets a "Dialing"-link state immediate followed by an "Idle"-link state as a failed try to connect, except when you cancel the dialing progress by choosing disconnect. If the try to connect is successful, on the link-state "Dialing" follows "Logging into gateway", not "Idle", you know. But when the modem of your provider is busy, after "Dialing" follows "Idle" because the modem has hanged up.
  63.  
  64.  
  65. Time Connected
  66.  
  67. The time you are connected is displayed in the third row of the status window. You can use this display to determine the number of telephone units you have used.
  68.  
  69.  
  70. Connection Sound
  71.  
  72. You can turn the connection sound on/off using the Preferences dialog (see below). When you're connecting to the Internet and the current try to connect succeeds, the connection sound is played. It is contained in the 'snd '-resource ID 128. You may want to replace this resource with your own sound. Do not choose a sound which is too long because
  73. A) it eats much memory and perhaps there could not be enough free room in the application zone of InterSLIP Remote to load the sound, and more important
  74. B) loading/playing the sound could take so much time that the computer misses some characters from the modem and the login prompt of your provider's server is not recognized.
  75.  
  76.  
  77. Scripting InterSLIP Remote
  78.  
  79. InterSLIP Remote can be controlled via AppleScript. It understands in addition to the standard commands the following commands:
  80.  
  81.  
  82. connect: Start an internet connection
  83.     connect
  84.         [redial  boolean]  -- Redial if busy?
  85.         [redial delay  small integer]  -- Delay between redials (secs)
  86.         [CCL delay  small integer]  -- Delay between removing CCL messages (secs)
  87.         [connection sound  boolean]  -- Play a connection sound?
  88.  
  89. You can use the connect command to start a connection. Optionally, four parameters can be passed - they will set the specified options before connection (shortcut for setting them using "set" - see below).
  90.  
  91. Example:
  92. tell application "IS Remote 1.2 PPC"
  93.     connect redial delay 20 CCL delay 30 with redial without connection sound
  94. end tell
  95.  
  96.  
  97. disconnect: Disconnect internet connection
  98.     disconnect
  99.  
  100. Use this command to cancel a running Internet connection. There are no parameters.
  101.  
  102.  
  103. clear log: Clear the log
  104.     clear log
  105.  
  106. Use this command to clear the log. Routines for accessing the log and connection times will be added in V2.0.
  107.  
  108.  
  109. Class options: InterSLIP Remote options
  110. Properties:
  111.     connection status  idle/waiting/dialing/logging into gateway/connected/hanging up  [r/o]  -- Status of connection
  112.     logging  boolean  -- Log connection times?
  113.     redial  boolean  -- Redial if busy?
  114.     redial delay  small integer  -- Delay between redials (secs)
  115.     CCL delay  small integer  -- Delay between removing CCL messages (secs)
  116.     connection sound  boolean  -- Play a connection sound?
  117.  
  118. These options can be used with the set/get command. You can coerce all of these properties (except for logging, redial, connection sound) to a string using the "as"-parameter of get. 
  119. Example:
  120. tell application "IS Remote 1.2 PPC"
  121.     get connection status as string
  122. end tell
  123.  
  124. Result: "Idle"
  125.  
  126. connection status
  127. This is an enumeration. You cannot set this option - it is read-only. Result is one of the following:
  128.   
  129. idle
  130. Connection is idle
  131.  
  132. waiting
  133. Waiting for modem
  134.  
  135. dialing
  136. Modem is dialing
  137.  
  138. logging into gateway
  139. CCL script is executed
  140.  
  141. connected
  142. Connection is running
  143.  
  144. hanging up
  145. Modem is hanging up
  146.  
  147. Example:
  148. tell application "IS Remote 1.2 PPC"
  149.     if connection status is idle then
  150.         connect
  151.     else
  152.         disconnect
  153.     end if
  154. end tell
  155.   
  156. logging, redial
  157. If logging is set to true, a log is kept; otherwise, no log is kept. If redial is true, InterSLIP Remote redials when it was not successful in connecting.
  158.  
  159. Example:
  160. tell application "IS Remote 1.2 PPC"
  161.     set logging to false
  162.     set redial to true
  163.     connect
  164.     repeat until connection status is connected
  165.     end repeat
  166.     set logging to true
  167. end tell
  168.   
  169. This script connects and (if needed, it redials until connecting is successful). This try to connect is not logged. Then it waits until connecting was successful. When you're connected, logging is turned on again. No log entry will show up which tells about this connection until you disconnect - disconnect will show up again.
  170.  
  171. redial delay, CCL delay
  172. You can use this variables to get and/or set the redial delay/CCL delay. For an explanation of this two delays see the "Preferences dialog" section.
  173.  
  174. connection sound
  175. To turn the connection sound on or off use this variable.
  176.  
  177.  
  178. Preferences dialog
  179.  
  180. Use this dialog for various settings. You can enter the "redial delay" in seconds. This is the time InterSLIP Remote waits before it tries to connect after a try failed. In the next edit field you can enter the "CCL message delay". This is the time InterSLIP Remote waits before removing a CCL message (such as "Waiting for login prompt...") from its display. Of course a CCL message is removed earlier when there is a newer message. You can also turn on/off the connection sound.
  181.  
  182.  
  183. Log
  184.  
  185. If "Keep Log" is turned on, InterSLIP Remote keeps a detailed log on all connect/disconnect tries. To turn "Keep Log" on/off, choose "Keep Log" from the "File"-menu or click on the "L" in the "Control"-window. The "L" is crossed out when the "Keep Log"-feature is disabled. To show the "Log"-window, in which the log is displayed, choose "Show Log" from the "Edit"-menu. To clear the log, choose "Clear log", also from the "Edit"-menu.
  186.     The following messages can be displayed in the "Log"-window, along with the time and date the actions took place:
  187.  
  188. A) Started trying to connect
  189. You hit the "Connect"-button, chose "Connect" from the "File"-menu or typed C.
  190.  
  191. B) Connected successful (number of tries: ##)
  192. You were connected successful to the Internet after ## tries to connect (>1 only when the "Auto Redial"-feature is activated.
  193.  
  194. C) Disconnected (connection duration: ##:##)
  195. You were disconnected from the Internet (by pressing the "Disconnect"-button, choosing "Disconnect" from the "File"-menu or typing D). The connection lasted ##:## minutes.
  196.  
  197. D) Connecting was aborted
  198. You canceled connecting (during the modem was dialing etc.) before you were connected.
  199.  
  200. E) Connection was (already) started, but not by IS Remote
  201. You started connecting to the Internet with another program than InterSLIP Remote while InterSLIP Remote was running -or- there was already a connection to the Internet before you launched InterSLIP Remote.
  202.  
  203. F) IS Remote was quit without disconnecting (measured connection duration: ##:##)
  204. You quit InterSLIP Remote without disconnecting. The time you were connected before you quit InterSLIP Remote was ##:##.
  205.     An alert will ask you if you really want to do this if you try it. InterSLIP Remote cannot measure the time you are connected to the Internet if it is not running all over the time you're connected!
  206.  
  207. At the bottom of the "Log"-window (scroll down until you reach it) there is the total number of log entries and the total connection time displayed.
  208.  
  209.  
  210. Version Overview
  211.  
  212. 1.2.2
  213. - fixed bug in AE Quit Handler Code (thanks again to Dan Crevier)
  214.    This bug caused to return IS Remote on some machines from
  215.    'quit'-AppleScript-calls returning a strange error code.
  216.    Unfortunately, this problem did not occur on my Mac.
  217.  
  218. 1.2.1
  219. - hopefully fixed the Preferences-dialog-bug in the 68k-version
  220. - fixed one very small memory leak in the AE Get Handler code (thanks to Dan Crevier)
  221. - corrected Readme-file
  222.  
  223. 1.2
  224. - scriptable (thanks to Dan Crevier)
  225. - deactivate control floating window in background
  226. - minor bug fixes (asks whether it should disconnect as soon as user quits and there is still a connection)
  227.  
  228. 1.1.1
  229. - InterSLIP Remote scrolled to the right/bottom when going off the left/top scroll arrow in the log window while holding down the mouse button. Fixed this bug.
  230. - fixed bug which caused InterSLIP Remote to crash when clicking in the Preferences dialog box (only in the 68K-version; I have a PowerMac and so I had trouble to find these two bugs.) [don't know the reason of the second bug; it disappeared after recompiling with CW7.]
  231. - corrected some spelling mistakes in this file
  232. - ported to CodeWarrior 7 IDE
  233.  
  234. 1.1
  235. - log window
  236. - preferences dialog
  237. - connection sound
  238. - rewrite application (cleaner, I hope less bugs)
  239.  
  240. 1.0.1
  241. - fixed bug which caused InterSLIP Remote to go to the debugger (and crash if it is not installed) when it cannot find its preferences file
  242.  
  243. 1.0
  244. - first release
  245.  
  246. Future Plans for V2.0
  247. I'm thinking about dividing up InterSLIP Remote into two applications: a scriptable background-only application and an application which contains only the user-interface.
  248.  
  249. I would also like to make InterSLIP Remote using the PPP protocol in addition to the SLIP protocol. Source code which shows how to control MacPPP is highly appreciated.
  250.  
  251. I've just started coding. I'm completely rewriting the user interface, making bigger buttons that say what they do. 
  252.  
  253. Future Plans for V1.3
  254. Some SLIP servers have limits on the amount of time you can spend in the net. You will be able to enter this time in the Preferences dialog and let InterSLIP Remote display another field in the window: ”Remaining Time“.
  255.  
  256. Adding a grow box to the Control window to make it possible to enlarge the window so that longer CCL messages fit in the window.
  257.  
  258.  
  259. Disclaimer
  260.  
  261. Matthias Wuttke hereby disclaims all warranties relating to this software, whether express or implied, including without limitation any implied warranties of merchantability or fitness for a particular purpose. Matthias Wuttke will not be liable for any special, incidental, consequential, indirect or similar damages due to loss of data or any other reason, even if Matthias Wuttke or an agent of his has been advised of the possibility of such damages.  In no event shall Matthias Wuttke be liable for any damages, regardless of the form of the claim.  The person using the software bears all risk as to the quality and performance of the software.
  262.  
  263.  
  264. Shareware
  265.  
  266. If you use InterSLIP Remote for more than two weeks and you decided to keep it, please send $5 shareware fee to me. If this is to much for you, send less.
  267.  
  268. You can send me the shareware fee directly - in this case, send cash only, please - or pay to Kagi Shareware using the "Register" program. If you live in Germany, you can transfer the money directly to my account, but please let me know that you transferred the fee.
  269.  
  270. Bankverbindungen:
  271. BLZ: 480 618 18
  272. Kto.-Nr.: 103 644 300
  273.  
  274. Volksbank Steinhagen
  275. Am Markt 19-23
  276. 33803 Steinhagen
  277. Germany
  278.  
  279.  
  280. About Kagi Shareware
  281. Kagi Shareware is a shareware registration service that is available to any shareware author and can accept a variety of payments from shareware users. Kagi Shareware handles all aspects of registering shareware; collection of payer information, processing of payments, replies to payers, detailed accounting to shareware authors, site license invoicing, etc. The idea is to make it easier for everyone involved with shareware; easier for users to pay shareware fees by providing a variety of payment methods, easier for shareware authors by easing the administrative burden.
  282.  
  283. For more information about Kagi look at their WWW-site (http://198.207.242.3) or contact Kee Nethery (kee@kagi.com).
  284.  
  285.  
  286. Thanks to
  287.  
  288. In no particular order:
  289. Dan Crevier (a lot of AE-stuff [AppleScript], beta-testing, bug-hunting)
  290. Troy Gaul (Infinity WDEF),
  291. F. Pottier (Floating Unit used in WuFrame),
  292. Marc Elmlund (he found lots of bugs),
  293. Sherman Frost (spelling mistakes, suggestions)
  294. Phil Kearny III, who pointed out the oversight that InterCon is not mentioned in this list ;)
  295. all guys at InterCon, especially Amanda Walker
  296. all users who complained about the bug(s) in V1.0, V1.1 & V1.2,
  297. all users who suggested new features implemented in V1.1,
  298. and, of course & last but not least, to all registered users!
  299.  
  300.  
  301. How to contact the author
  302.  
  303. Please tell me any spelling-mistakes in this Readme (if there are any left :). Please report any bugs or problems you have with InterSLIP Remote - I will try to fix them in the next release. Suggestions are very welcome. If you decide to contact me please send me e-mail (if possible) - it's much faster and not as expensive as snail mail :)
  304.  
  305. email (Internet):
  306. matthias@kagi.com
  307. wuttke@stein.teuto.de
  308.  
  309. Snail mail:
  310. Matthias Wuttke
  311. Hilterweg 14
  312. 33803 Steinhagen
  313. Germany
  314. Phone: +49 (0) (5204) 8502
  315.  
  316. PS: Sorry for any mistakes in the spelling! Please tell me my mistakes, I'll correct them.
  317.